/*
 * Copyright 2022 The Backstage Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { createApiRef } from '@backstage/core-plugin-api';
import {
  GetExploreToolsRequest,
  GetExploreToolsResponse,
} from '@backstage/plugin-explore-common';

/**
 * Interface for the explore plugin.
 *
 * @public
 */
export interface ExploreApi {
  /**
   * Returns a list of explore tools.
   *
   * @param request - The request query options
   */
  getTools(request?: GetExploreToolsRequest): Promise<GetExploreToolsResponse>;
}

/**
 * @public
 */
export const exploreApiRef = createApiRef<ExploreApi>({
  id: 'plugin.explore.service',
});
